GetItemInventoryQuantitiesByStockCode (Method)

Description

Gets the inventory quantity for the item by stock code in the specified unit of measure. Introduced in v2.20

Request (GetItemInventoryQuantitiesByStockCodeSoapIn)

The request body is of type GetItemInventoryQuantitiesByStockCode.

Request Body Parameters

Name	Description	Data Type
StockCode	The stock code for the item.	xml:string
UOM	The type of the unit of measure. Valid options are as follows: Stocking: "stocking", "STK", "S" or 1 Alternate: "alternate", "ALT", "A" or 2 Other: "other", "OTH", "O" or 3 Preferred: "preferred", "PREF", "P" or 0 or Specify the UOM by the unit label text prefixed with an @ sign. For example "@EA"	xml:anyType
Options		xml:string

Name

Description

Data Type

StockCode

The stock code for the item.

xml:string

UOM

The type of the unit of measure.

Valid options are as follows:

Stocking: "stocking", "STK", "S" or 1
Alternate: "alternate", "ALT", "A" or 2
Other: "other", "OTH", "O" or 3
Preferred: "preferred", "PREF", "P" or 0

or

Specify the UOM by the unit label text prefixed with an @ sign. For example "@EA"

xml:anyType

Options

xml:string

Example

The following example shows how to perform the web operation in CyberStore.

Javascript

MakeAJAXCall("Inventory.GetItemInventoryQuantitiesByStockCode", {
    StockCode:'A100', 
    UOM:0
},console.log);

200 Response (GetItemInventoryQuantitiesByStockCodeSoapOut)

The response body is of type GetItemInventoryQuantitiesByStockCodeResponse.

Response Body Parameters

Name	Description	Data Type
GetItemInventoryQuantitiesByStockCodeResult	{ "Data": { "StockCode": "A100", "UOM": "EA", "InventoryQty": 107806.000000, "DisplayString": "107,806 EA In Stock", "Warehouses": [ { "Warehouse": "E", "Description": "Eastern Zone Warehouse", "InventoryQty": 7031.0 }, { "Warehouse": "FG", "Description": "Finished Goods Warehouse", "InventoryQty": 4498.0 }, { "Warehouse": "N", "Description": "Northern Warehouse", "InventoryQty": 89422.0 }, { "Warehouse": "S", "Description": "Southern Warehouse", "InventoryQty": 6855.0 } ] }, "Result": { "Success": true, "Message": "Inventory results returned successfully.", "ElapsedTime": "60 ms" } }	xml:string

Name

Description

Data Type

GetItemInventoryQuantitiesByStockCodeResult

{
    "Data": {
        "StockCode": "A100",
        "UOM": "EA",
        "InventoryQty": 107806.000000,
        "DisplayString": "107,806 EA In Stock",
        "Warehouses": [
            {
                "Warehouse": "E",
                "Description": "Eastern Zone Warehouse",
                "InventoryQty": 7031.0
            },
            {
                "Warehouse": "FG",
                "Description": "Finished Goods Warehouse",
                "InventoryQty": 4498.0
            },
            {
                "Warehouse": "N",
                "Description": "Northern Warehouse",
                "InventoryQty": 89422.0
            },
            {
                "Warehouse": "S",
                "Description": "Southern Warehouse",
                "InventoryQty": 6855.0
            }
        ]
    },
    "Result": {
        "Success": true,
        "Message": "Inventory results returned successfully.",
        "ElapsedTime": "60 ms"
    }
}

xml:string